BOI APIs

Please find the APIs supported by each entity of BOI...

Key Description
Live Available on our API Platform
NA Not applicable - functionality not available on channel
FV Future version - on our road map for a future version release
TBC To be confirmed
TBD To be decommissioned
Note: UK Post Office Current Accounts have been discontinued, with all accounts now closed. Access to these Accounts will not be made available via APIs. Post Office and AA Credit Cards provided by Bank Of Ireland UK are being sold to a new Credit Card issuer. Access to Accounts will not be available on these Credit Card portfolios until enabled by the new card issuer.

APIs

BOI API Endpoints

BOI Sandbox

Production APIs

Bank of Ireland (ROI) Bank of Ireland UK
365 online BOL 365 online BOL
DCR v3.3 POST /register Live TBC Live
PUT /register/{ClientId} Live TBC Live
DCR v1.2.0 POST /register Live Live NA
AISP v3.1.8 POST /account-access-consents FV TBC TBC FV FV
GET /account-access-consents/{ConsentId} FV TBC TBC FV FV
DELETE /account-access-consents/{ConsentId} FV TBC TBC FV FV
GET /accounts FV TBC TBC FV FV
GET /accounts/{AccountId} FV TBC TBC FV FV
GET /accounts/{AccountId}/balances FV TBC TBC FV FV
GET /accounts/{AccountId}/transactions FV TBC TBC FV FV
GET /accounts/{AccountId}/beneficiaries FV NA NA FV FV
GET /accounts/{AccountId}/product FV NA NA FV NA
GET /accounts/{AccountId}/scheduled-payments FV NA NA FV FV
GET /accounts/{AccountId}/standing-orders FV NA NA FV NA
GET /accounts/{AccountId}/statements FV NA NA FV NA
GET /accounts/{AccountId}/statements/{StatementId}/file FV NA NA FV NA
GET /accounts/{AccountId}/statements/{StatementId} NA NA NA NA NA
GET /accounts/{AccountId}/statements/{StatementId}/transactions NA NA NA NA NA
GET /accounts/{AccountId}/parties NA NA NA NA NA
GET /accounts/{AccountId}/party NA NA NA NA NA
GET /party NA NA NA NA NA
GET /accounts/{AccountId}/direct-debits NA NA NA NA NA
GET /accounts/{AccountId}/offers NA NA NA NA NA
PISP v3.1.8 POST /domestic-payment-consents FV TBC TBC FV FV
GET /domestic-payment-consents/{ConsentId} FV TBC TBC FV FV
GET /domestic-payment-consents/{ConsentId}/funds-confirmation FV TBC TBC FV FV
POST /domestic-payments FV TBC TBC FV FV
GET /domestic-payments/{DomesticPaymentId} FV TBC TBC FV FV
POST /domestic-scheduled-payment-consents FV TBC TBC FV FV
GET /domestic-scheduled-payment-consents/{ConsentId} FV TBC TBC FV FV
POST /domestic-scheduled-payments FV TBC TBC FV FV
GET /domestic-scheduled-payments/{DomesticScheduledPaymentId} FV TBC TBC FV FV
POST /domestic-standing-order-consents FV TBC NA FV NA
GET /domestic-standing-order-consents/{ConsentId} FV TBC NA FV NA
POST /domestic-standing-orders FV TBC NA FV NA
GET /domestic-standing-orders/{DomesticStandingOrderId} FV TBC NA FV NA
POST /file-payment-consents FV NA TBC NA FV
POST /file-payment-consents/{ConsentId}/file FV NA TBC NA FV
GET /file-payment-consents/{ConsentId} FV NA TBC NA FV
GET /file-payment-consents/{ConsentId}/file FV NA TBC NA FV
POST /file-payments FV NA TBC NA FV
GET /file-payments/{FilePaymentId} FV NA TBC NA FV
GET /file-payments/{FilePaymentId}/report-file FV NA TBC NA FV
POST /international-payment-consents FV TBC TBC FV FV
GET /international-payment-consents/{ConsentId} FV TBC TBC FV FV
GET /international-payment-consents/{ConsentId}/funds-confirmation FV TBC TBC FV FV
POST /international-payments FV TBC TBC FV FV
GET /international-payments/{InternationalPaymentId} FV TBC TBC FV FV
POST /international-scheduled-payment-consents FV NA TBC NA FV
GET /international-scheduled-payment-consents/{ConsentId} FV NA TBC NA FV
GET /international-scheduled-payment-consents/{ConsentId}/funds-confirmation FV NA TBC NA FV
POST /international-scheduled-payments FV NA TBC NA FV
GET /international-scheduled-payments/{InternationalScheduledPaymentId} FV NA TBC NA FV
POST /international-standing-order-consents NA NA NA NA NA
GET /international-standing-order-consents/{ConsentId} NA NA NA NA NA
POST /international-standing-orders NA NA NA NA NA
GET /international-standing-orders/{InternationalStandingOrderId} NA NA NA NA NA
CBPII v3.1.8 POST /funds-confirmation-consents FV FV FV FV FV
GET /funds-confirmation-consents/{ConsentId} FV FV FV FV FV
DELETE /funds-confirmation-consents/{ConsentId} FV FV FV FV FV
POST /funds-confirmations FV FV FV FV FV
Event Notification API v3.1.8 POST /event-subscriptions FV TBC TBC FV FV
GET/event-subscriptions FV TBC TBC FV FV
PUT/event-subscriptions/{EventSubscriptionId} FV TBC TBC FV FV
DELETE/event-subscriptions/{EventSubscriptionId} FV TBC TBC FV FV
POST/events FV TBC TBC FV FV
AISP v3.0.0 POST /account-access-consents Live Live Live Live Live
GET /account-access-consents/{ConsentId} Live Live Live Live Live
DELETE /account-access-consents/{ConsentId} Live Live Live Live Live
GET /accounts Live Live Live Live Live
GET /accounts/{AccountId} Live Live Live Live Live
GET /accounts/{AccountId}/balances Live Live Live Live Live
GET /accounts/{AccountId}/transactions Live Live Live Live Live
GET /accounts/{AccountId}/beneficiaries Live NA NA Live NA
GET /accounts/{AccountId}/product Live NA NA Live NA
GET /accounts/{AccountId}/scheduled-payments Live NA NA Live NA
GET /accounts/{AccountId}/standing-orders Live NA NA Live NA
GET /accounts/{AccountId}/statements Live NA NA Live NA
GET /accounts/{AccountId}/statements/{StatementId}/file Live NA NA Live NA
GET /accounts/{AccountId}/statements/{StatementId} NA NA NA NA NA
GET /accounts/{AccountId}/statements/{StatementId}/transactions NA NA NA NA NA
GET /accounts/{AccountId}/party NA NA NA NA NA
GET /accounts/{AccountId}/direct-debits Live NA NA NA NA
GET /accounts/{AccountId}/offers NA NA NA NA NA
PISP v3.0.0 POST /domestic-payment-consents Live Live Live Live Live
GET /domestic-payment-consents/{ConsentId} Live Live Live Live Live
POST /domestic-payments Live Live Live Live Live
GET /domestic-payments/{DomesticPaymentId} Live Live Live Live Live
POST /domestic-scheduled-payment-consents Live Live NA Live NA
GET /domestic-scheduled-payment-consents/{ConsentId} Live Live NA Live NA
POST /domestic-scheduled-payments Live Live NA Live NA
GET /domestic-scheduled-payments/{DomesticScheduledPaymentId} Live Live NA Live NA
POST /domestic-standing-order-consents Live NA NA Live NA
GET /domestic-standing-order-consents/{ConsentId} Live NA NA Live NA
POST /domestic-standing-orders Live NA NA Live NA
GET /domestic-standing-orders/{DomesticStandingOrderId} Live NA NA Live NA
POST /file-payment-consents Live NA NA NA NA
POST /file-payment-consents/{ConsentId}/file Live NA NA NA NA
GET /file-payment-consents/{ConsentId} Live NA NA NA NA
GET /file-payment-consents/{ConsentId}/file Live NA NA NA NA
POST /file-payments Live NA NA NA NA
GET /file-payments/{FilePaymentId} Live NA NA NA NA
GET /file-payments/{FilePaymentId}/report-file Live NA NA NA NA
POST /international-payment-consents Live NA NA NA NA
GET /international-payment-consents/{ConsentId} Live NA NA NA NA
POST /international-payments Live NA NA NA NA
GET /international-payments/{InternationalPaymentId} Live NA NA NA NA
POST /international-scheduled-payment-consents Live NA NA NA NA
GET /international-scheduled-payment-consents/{ConsentId} Live NA NA NA NA
POST /international-scheduled-payments Live NA NA NA NA
GET /international-scheduled-payments/{InternationalScheduledPaymentId} Live NA NA NA NA
POST /international-standing-order-consents NA NA NA NA NA
GET /international-standing-order-consents/{ConsentId} NA NA NA NA NA
POST /international-standing-orders NA NA NA NA NA
GET /international-standing-orders/{InternationalStandingOrderId} NA NA NA NA NA
CBPII v3.0.0 POST /funds-confirmation-consents Live NA NA NA NA
GET /funds-confirmation-consents/{ConsentId} Live NA NA NA NA
DELETE /funds-confirmation-consents/{ConsentId} Live NA NA NA NA
POST /funds-confirmations Live NA NA NA NA
AISP v2.0.0
(To be decommissioned – Nov 2021)
POST /account-requests NA NA NA TBD NA
GET /account-requests/{AccountRequestId} NA NA NA TBD NA
DELETE /account-requests/{AccountRequestId} NA NA NA TBD NA
GET /accounts NA NA NA TBD NA
GET /accounts/{AccountId} NA NA NA TBD NA
GET /accounts/{AccountId}/balances NA NA NA TBD NA
GET /accounts/{AccountId}/transactions NA NA NA TBD NA
GET /accounts/{AccountId}/beneficiaries NA NA NA TBD NA
GET /accounts/{AccountId}/product NA NA NA TBD NA
GET /accounts/{AccountId}/direct-debits NA NA NA TBD NA
GET /accounts/{AccountId}/scheduled-payments NA NA NA NA NA
GET /accounts/{AccountId}/standing-orders NA NA NA TBD NA
GET /accounts/{AccountId}/statements NA NA NA NA NA
GET /accounts/{AccountId}/statements/{StatementId} NA NA NA NA NA
GET /accounts/{AccountId}/statements/{StatementId}/file NA NA NA NA NA
GET /accounts/{AccountId}/statements/{StatementId}/transactions NA NA NA NA NA
GET /accounts/{AccountId}/offers NA NA NA NA NA
GET /accounts/{AccountId}/party NA NA NA NA NA
PISP v1.1.0
(To be decommissioned – Feb 2022)
POST /payments NA NA NA TBD NA
GET /payments/{PaymentId} NA NA NA NA NA
POST /payment-submissions NA NA NA TBD NA
GET /payment-submissions/{PaymentSubmissionId} NA NA NA NA NA